feat: add command examples#2
Merged
Patrik Simek (patriksimek) merged 1 commit intomainfrom Apr 17, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds generated example command strings to CLI help output and introduces a docs generator that renders command reference markdown from MCP tool metadata.
Changes:
- Introduces
src/examples.tshelpers to format example values and assemble single-/multi-line shell commands. - Shows an “Example” section in command help output when a tool provides examples.
- Adds
scripts/build-docs.tsandnpm run build:docsto generatedocs/*.mdreference pages.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/examples.spec.ts | Adds unit tests for example formatting and wrapping behavior. |
| test/commands.spec.ts | Updates camelToKebab import source and adjusts help-group casing expectation. |
| src/examples.ts | New example/value formatting utilities used by CLI help/docs. |
| src/commands.ts | Integrates example formatting into per-command help text and imports shared helpers. |
| src/categories.ts | Updates category titles/group labels to sentence-style casing. |
| scripts/build-docs.ts | New docs generator that renders option tables and examples from MCP tools. |
| package.json | Bumps version, adds build:docs, updates SDK dependency. |
| package-lock.json | Lockfile updates for version/dependency changes. |
| README.md | Adds an npx @makehq/cli ... usage example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add examples to commands.